home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / util / wb / AddIcon.lha / addicon / AddIcon_English.Doc < prev    next >
Text File  |  1998-12-11  |  6KB  |  194 lines
  1. Introduction
  2. ------------
  3. AddIcon is a litle program that makes it easy to add standard icons to
  4. files.
  5.  
  6. AddIcon was written in Oberon-A ©1995 by Frank Copeland.
  7.  
  8.  
  9. If you use AddIcon regularly or you have any comments, bugreports or
  10. you want to pay me for AddIcon, even though you don't have to, then
  11. feel free to write to me (see address at the bottom of this document).
  12.  
  13.  
  14. Copyright
  15. ---------
  16. AddIcon 1.0 is Copyright 1997 Morten Bjergstrøm.
  17.  
  18. This piece of software is freely distributeable but still copyrighted.
  19. Therefore you are not allowed to change the program in anyway and you
  20. are not allowed to remove or add anything to the archive.
  21.  
  22. You are allowed to spread this program as much as you like but you may
  23. not make any profit of it.
  24.  
  25. I cannot in anyway be held responsible for any damage AddIcon may do to
  26. your hardware or software or anything else. You use AddIcon entirely on
  27. your OWN risk.
  28.  
  29.  
  30. It is allowed to include this program on public domain/shareware disks
  31. if the price of one disk doesn't exceed 15 Dkr (4DM, $2).
  32.  
  33. It is allowed to include this program on CD-ROMS if the price of the
  34. CD-ROM doesn't exceed the price of an Aminet CD (129Dkr, 20-25DM)
  35.  
  36. Magazines have to get my written permission to include AddIcon on their
  37. coverdisks/cdroms. If a magazine gets my written permission to use AddIcon
  38. on one of their coverdisks/cdroms they have to send me a copy of that
  39. magazine including the coverdisk/cdrom free of charge.
  40.  
  41.  
  42. Requirements
  43. ------------
  44. AddIcon requires OS3.0 or higher and some installed datatypes to work.
  45. The standard icons have to be in ENV:SYS/
  46. Their names should be def_<name of icon>.info
  47.  
  48. Example:
  49.   def_picture.info
  50.   def_guide.info
  51.  
  52. Etc.
  53.  
  54. In addition the program needs AddIcon.Data in the S: directory.
  55. (Look at the Configuration chapter)
  56.  
  57.  
  58. Note: If you use datatypes.library V45.3 then you will loose 60-80 bytes
  59.       of memory for each file you check because of a bug in this version
  60.       of datatypes.library. (The bug lies in the ObtainDataType call)
  61.  
  62.       If you have a possibility to EMail the author of datatypes.library
  63.       V45.3 and you use the library yourself then please email him and ask
  64.       him if he wants to correct this bug. (If I could I would EMail him
  65.       myself but at the time of writing I can't make the EMail function
  66.       work at the local library.)
  67.  
  68.  
  69. Installation
  70. ------------
  71. Just copy the AddIcon drawer where ever you want.
  72. (Danish users can delete the English version of AddIcon and
  73. English users can delete the Danish version.)
  74.  
  75.  
  76. Usage
  77. -----
  78. AddIcon can be started from either the Shell or the Workbench.
  79.  
  80. When started from the Shell you have to make sure that you have a stack
  81. size at at least 6000 bytes else you will get a Guru-Meditation.
  82.  
  83. The program supports the following parameters:
  84.  
  85. FILES          The filenames of all the files you want to give an icon.
  86.                If the files are in a different directory you have to
  87.                enter the full path.
  88.  
  89. DONTASKADDICON With this switch you choose if you want a requester or not
  90.                before an icon is added to your file.
  91.  
  92.  
  93.  
  94. When started from the Workbench you have to make sure that you have a stack
  95. size at at least 5000 bytes else you will probably get a Guru-Meditation.
  96. If the program starts up with no errors you will get an AppIcon on your
  97. Workbench screen.
  98. Just drop some files on this icon and the files will get standard icons.
  99.  
  100. AddIcon supports one tooltype:
  101.  
  102. DONTASKADDICON
  103.  
  104. IF you want AddIcon to ask you before it adds an icon then write
  105. DONTASKADDICON=NO in the tooltype window or just delete the tooltype.
  106.  
  107. IF you don't want AddIcon to ask you before it adds in icon then
  108. write DONTASKADDICON=YES in the tooltype window. (You have to write
  109. YES in uppercase letters else AddIcon will ask you before it adds an icon
  110. to a file)
  111.  
  112. To quit AddIcon just doubleclick on the AppIcon and you will be asked if
  113. you really want to quit.
  114.  
  115.  
  116. Configuration
  117. -------------
  118. To find out which icon to add to a given filetype AddIcon uses a config
  119. file in S:
  120. This file should have the name AddIcon.Data.
  121.  
  122. This file can be generated by the program. Just follow the onscreen
  123. information AddIcon gives you if it encounters a filetype without an
  124. associated icon.
  125.  
  126. You also have the possibility to edit this file by hand with a simple text
  127. editor like Ed. (This is not a recommended operation if you are not quite
  128. sure about what you are doing and in fact there is no reason to do this.
  129. It can lead to errors or even Guru-Meditations :-( )
  130.  
  131. The format of the configfile is:
  132.  
  133. Everything after a ';' is treated as a comment just like in AmigaDos
  134. scripts.
  135.  
  136. Example:
  137. ; This is a comment
  138.  
  139. The definition of what icon to add to a filetype is quite easy.
  140. First you have to find out what the datatype descriptor name is for the
  141. file. You can use AddIcon to figure that out. You just take your file
  142. and drops it on the AddIcon AppIcon (remember to turn off the
  143. DONTASKADDICON option) and you will be told what type your file is.
  144.  
  145. The requester you get could look something like this:
  146.  
  147. Add icon to Test.guide
  148. of the type AmigaGuide?
  149.             ----------
  150.  
  151. The underlined word is the datatype descriptor you were looking for.
  152.  
  153. In the AddIcon.Data file you write this descriptor name (case sensitive)
  154. on an empty line then you write a '=' sign and then you write the name
  155. of the icon (no path, no def_ and no .info). After that please press enter
  156. if you don't the program's own configuration routine can get confused.
  157.  
  158. Example:
  159.  
  160. AmigaGuide=AmigaGuide
  161.     |          |
  162. Descriptor The name of the icon in ENV:SYS/ (In this case the full name
  163.                                              will be:
  164.                                              ENV:SYS/def_AmigaGuide.info)
  165.  
  166.  
  167.  
  168. History
  169. -------
  170. 11/9/1997: 1.0 First version.
  171.  
  172.  
  173. To do
  174. -----
  175. - Stack check code
  176. - Locale support if anybody needs it. Else only a Danish and an English
  177.   version will be available.
  178. - Error messages if anybody needs them.
  179. - Other improvements. Tell me what you need.
  180.  
  181.  
  182. Address
  183. -------
  184. Mail address:
  185.  
  186.   Morten Bjergstrøm
  187.   Krovænget 11
  188.   4671 Strøby
  189.   Denmark
  190.  
  191.  
  192. EMail address:
  193.   mbjergstroem@hotmail.com
  194.